The following table lists and describes methods of the CygNet Event Summary Control. Methods are accessed using the control's script editor.
| Method | Description | |
|---|---|---|
|
The AboutBox method displays an About dialog box for the control. |
||
|
The Cancel method closes an object and TheView. |
||
| The ClearFilters method clears all AUD rules and filters from the control. | ||
| The ClearFilters method clears all ELSALM rules and filters from the control. | ||
|
The ClearFilters method clears all ELS Event rules and filters from the control. |
||
|
The DisplayNextRecords method shows the next available record. |
||
|
The EnableAllAudFilters method uses all AUD service rules and filters |
||
|
The EnableAllElsAlarmFilters method uses all ELSALM service rules and filters. |
||
|
The EnableAllElsEventFilters method uses all ELS service rules and filters. |
||
|
The EnableAudFilter method uses the specified AUD service filter. |
||
|
The EnableElsAlarmFilter method uses the specified ELSALM service filter. |
||
|
The EnableElsEventFilter method uses the specified ELS service filter. |
||
|
The Export method exports the contents of the grid to a temporary CSV file and opens the file with the default spreadsheet viewer for the user to view and save to disk. |
||
|
The GetAudError method retrieves an error list from the AUD service. |
||
|
The GetElsAlarmError method retrieves an error list from the ELSALM service. |
||
|
The GetElsAlarmFilterNames method retrieves filter names from the ELSALM service. |
||
|
The GetElsEventError method retrieves an error list from the ELS service. |
||
|
The GetElsEventFilterNames method retrieves filter names from the ELS service. |
||
|
The GetEventSummaryCustomAttribute method retrieves custom event attributes. |
||
|
The GetMaxCacheSize method retrieves the value for maximum cache size of the specified service (AUD, ELS, or ELSALM) Options are integers:
The method will fail (return "-1") if an option other than 1, 2, or 3 is entered. When successful, returned values are between 20,000 and 10,000,000 records. |
||
|
The GetMostRecentFirst method retrieves the most recent record first. |
||
|
The GetNumRecords method retrieves only numerical records. |
||
|
The GetPropertyValue method retrieves the value of the selected property. Example
|
||
|
The GetRowFacility method retrieves the facility for the selected row. |
||
|
The GetRowHandles method retrieves the handles for the selected row. Example
|
||
|
The GetRowPoint method retrieves the point for the selected row. |
||
|
The HasNextElsAlarmRecords method displays whether or not there is a subsequent ELS alarm record after the currently selected record. |
||
|
The IsAudFilterEnabled method displays whether or not AUD service filters are enabled. |
||
|
The IsElsAlarmFilterEnabled method displays whether or not ELSALM service filters are enabled. |
||
|
The IsElsEventFilterEnabled method displays whether or not ELS service filters are enabled. |
||
|
The Print method prints the contents of the control, grid, or viewer. When this method is called, the Print dialog box is shown to allow configuration. |
||
|
The Refresh method refreshes the contents of the control from the Current Value Service (CVS). |
||
|
The RefreshRow method refreshes the contents of the selected row. |
||
|
The RowHasPoint method displays whether or not the selected record row has a corresponding Point configured in the system. |
||
|
The GetEventSummaryCustomAttribute method sets custom event attributes. |
||
|
The SetMaxCacheSize method sets the maximum value for the cache size for the specified service (AUD, ELS, or ELSALM) Options are integers:
The method will fail (return "False") if an option other than 1, 2, or 3 is entered. Possible values are between 20,000 and 10,000,000 records. If the specified cache is out of range, the method will fail (return "False"). If the method is not used, the default value is 20,000 records. |
||
|
The GetMostRecentFirst method sets the most recent record. |
||
|
The ShowProperties method displays the properties for the currently selected record. |